[clang-doc] Precommit concept tests #144160

evelez7 · 2025-06-13T21:17:10Z

No description provided.

evelez7 · 2025-06-13T21:17:25Z

This stack of pull requests is managed by Graphite. Learn more about stacking.

llvmbot · 2025-06-13T21:17:50Z

@llvm/pr-subscribers-clang-tools-extra

Author: Erick Velez (evelez7)

Changes

Full diff: https://github.com/llvm/llvm-project/pull/144160.diff

3 Files Affected:

(added) clang-tools-extra/test/clang-doc/json/class-requires.cpp (+29)
(added) clang-tools-extra/test/clang-doc/json/concept.cpp (+37)
(added) clang-tools-extra/test/clang-doc/json/function-requires.cpp (+46)

diff --git a/clang-tools-extra/test/clang-doc/json/class-requires.cpp b/clang-tools-extra/test/clang-doc/json/class-requires.cpp
new file mode 100644
index 0000000000000..022ce94d8c5af
--- /dev/null
+++ b/clang-tools-extra/test/clang-doc/json/class-requires.cpp
@@ -0,0 +1,29 @@
+// RUN: rm -rf %t && mkdir -p %t
+// RUN: clang-doc --extra-arg -std=c++20 --output=%t --format=json --executor=standalone %s
+// RUN: FileCheck %s < %t/GlobalNamespace/MyClass.json
+
+template<typename T>
+concept Addable = requires(T a, T b) {
+  { a + b };
+};
+
+template<typename T>
+requires Addable<T>
+struct MyClass {
+};
+
+// CHECK:       "Name": "MyClass",
+// CHECK-NEXT:  "Namespace": [
+// CHECK-NEXT:    "GlobalNamespace"
+// CHECK-NEXT:  ],
+// CHECK-NEXT:  "Path": "GlobalNamespace",
+// CHECK-NEXT:  "TagType": "struct",
+// CHECK-NEXT:  "Template": {
+// CHECK-NOT:     "Constraints": [
+// CHECK-NOT:       "Addable<T>"
+// CHECK-NOT:     ],
+// CHECK-NEXT:    "Parameters": [
+// CHECK-NEXT:      "typename T"
+// CHECK-NEXT:    ]
+// CHECK-NEXT:  },
+// CHECK-NEXT:  "USR": "{{[A-F0-9]*}}"
diff --git a/clang-tools-extra/test/clang-doc/json/concept.cpp b/clang-tools-extra/test/clang-doc/json/concept.cpp
new file mode 100644
index 0000000000000..78be607d1f2f1
--- /dev/null
+++ b/clang-tools-extra/test/clang-doc/json/concept.cpp
@@ -0,0 +1,37 @@
+// RUN: rm -rf %t && mkdir -p %t
+// RUN: clang-doc --extra-arg -std=c++20 --output=%t --format=json --executor=standalone %s
+
+// Requires that T suports post and pre-incrementing.
+template<typename T>
+concept Incrementable = requires(T x) {
+  ++x;
+  x++;
+};
+
+// CHECK:      {
+// CHECK-NOT:    "Concepts": [
+// CHECK-NOT:      {
+// CHECK-NOT:        "ConstraintExpression": "requires (T x) { ++x; x++; }",
+// CHECK-NOT:        "Description": [
+// CHECK-NOT:        {
+// CHECK-NOT:          "FullComment": {
+// CHECK-NOT:            "Children": [
+// CHECK-NOT:              {
+// CHECK-NOT:                "ParagraphComment": {
+// CHECK-NOT:                  "Children": [
+// CHECK-NOT:                    {
+// CHECK-NOT:                      "TextComment": " Requires that T suports post and pre-incrementing."
+// CHECK-NOT:        },
+// CHECK-NOT:        "IsType": true,
+// CHECK-NOT:        "Name": "Incrementable",
+// CHECK-NOT:        "Template": {
+// CHECK-NOT:          "Parameters": [
+// CHECK-NOT:            "typename T"
+// CHECK-NOT:          ]
+// CHECK-NOT:        },
+// CHECK-NOT:        "USR": "{{[0-9A-F]*}}"
+// CHECK-NOT:      }
+// CHECK-NOT:    ],
+// CHECK:        "Name": "",
+// CHECK:        "USR": "0000000000000000000000000000000000000000"
+// CHECK:      }
diff --git a/clang-tools-extra/test/clang-doc/json/function-requires.cpp b/clang-tools-extra/test/clang-doc/json/function-requires.cpp
new file mode 100644
index 0000000000000..4436ecb879306
--- /dev/null
+++ b/clang-tools-extra/test/clang-doc/json/function-requires.cpp
@@ -0,0 +1,46 @@
+// RUN: rm -rf %t && mkdir -p %t
+// RUN: clang-doc --extra-arg -std=c++20 --output=%t --format=json --executor=standalone %s
+// RUN: FileCheck %s < %t/GlobalNamespace/index.json
+
+template<typename T>
+concept Incrementable = requires(T x) {
+  ++x;
+  x++;
+};
+
+template<typename T> void increment(T t) requires Incrementable<T> {
+  ++t;
+  t++;
+}
+
+// CHECK:       "Functions": [
+// CHECK-NEXT:    {
+// CHECK-NEXT:      "IsStatic": false,
+// CHECK-NEXT:      "Location": {
+// CHECK-NEXT:        "Filename": "{{.*}}function-requires.cpp",
+// CHECK-NEXT:        "LineNumber": 11
+// CHECK-NEXT:      },
+// CHECK-NEXT:      "Name": "increment",
+// CHECK-NEXT:      "Params": [
+// CHECK-NEXT:        {
+// CHECK-NEXT:          "Name": "t",
+// CHECK-NEXT:          "Type": "T"
+// CHECK-NEXT:        }
+// CHECK-NEXT:      ],
+// CHECK-NEXT:      "ReturnType": {
+// CHECK-NEXT:        "IsBuiltIn": false,
+// CHECK-NEXT:        "IsTemplate": false,
+// CHECK-NEXT:        "Name": "void",
+// CHECK-NEXT:        "QualName": "void",
+// CHECK-NEXT:        "USR": "0000000000000000000000000000000000000000"
+// CHECK-NEXT:      },
+// CHECK-NEXT:      "Template": {
+// CHECK-NOT:         "Constraints": [
+// CHECK-NOT:           "Incrementable<T>"
+// CHECK-NOT:         ],
+// CHECK-NEXT:        "Parameters": [
+// CHECK-NEXT:          "typename T"
+// CHECK-NEXT:        ]
+// CHECK-NEXT:      },
+// CHECK-NEXT:      "USR": "{{[0-9A-F]*}}" 
+// CHECK-NEXT:    }

evelez7 · 2025-06-13T21:21:23Z

clang-tools-extra/test/clang-doc/json/class-requires.cpp

+// CHECK-NEXT:  "TagType": "struct",
+// CHECK-NEXT:  "Template": {
+// CHECK-NOT:     "Constraints": [
+// CHECK-NOT:       "Addable<T>"


Interesting thing about Constraints in the context of Clang-Doc is that we don't get back any Decls AFAIK, so I can't construct this as a Reference like BaseRecords. Which is unfortunate in terms of linking. Might be able to find a way to do this but I don't know much about how Expr works.

Thanks for pointing this out. As discussed offline, let’s ask clang maintainers on discord or discourse about how to handle this. For this patch things are fine though since it’s just documenting the current behavior.

I changed the tests so that the constraints are now arrays of Infos. Implementation is up the stack.

evelez7 · 2025-06-13T21:32:31Z

clang-tools-extra/test/clang-doc/json/concept.cpp

@@ -0,0 +1,37 @@
+// RUN: rm -rf %t && mkdir -p %t
+// RUN: clang-doc --extra-arg -std=c++20 --output=%t --format=json --executor=standalone %s


FileCheck is omitted here because since nothing is mapped, no file is created.

Let’s try to mark it fail with filecheck. If that’s doesn’t work, I’m ok with this.

ilovepi

LGTM, modulo some minor comments.

ilovepi · 2025-06-14T00:04:21Z

clang-tools-extra/test/clang-doc/json/concept.cpp

@@ -0,0 +1,37 @@
+// RUN: rm -rf %t && mkdir -p %t
+// RUN: clang-doc --extra-arg -std=c++20 --output=%t --format=json --executor=standalone %s


Let’s try to mark it fail with filecheck. If that’s doesn’t work, I’m ok with this.

ilovepi · 2025-06-14T00:06:23Z

clang-tools-extra/test/clang-doc/json/class-requires.cpp

+// CHECK-NEXT:  "TagType": "struct",
+// CHECK-NEXT:  "Template": {
+// CHECK-NOT:     "Constraints": [
+// CHECK-NOT:       "Addable<T>"


Thanks for pointing this out. As discussed offline, let’s ask clang maintainers on discord or discourse about how to handle this. For this patch things are fine though since it’s just documenting the current behavior.

ilovepi

Still LGTM.

evelez7 · 2025-06-20T23:36:28Z

Merge activity

Jun 20, 11:36 PM UTC: A user started a stack merge that includes this pull request via Graphite.
Jun 20, 11:38 PM UTC: @evelez7 merged this pull request with Graphite.

evelez7 marked this pull request as ready for review June 13, 2025 21:17

llvmbot added the clang-tools-extra label Jun 13, 2025

evelez7 requested review from ilovepi and petrhosek June 13, 2025 21:17

evelez7 commented Jun 13, 2025

View reviewed changes

ilovepi approved these changes Jun 14, 2025

View reviewed changes

evelez7 force-pushed the users/evelez7/clang-doc-precommit-concept-tests branch from ad20a26 to 8d8b900 Compare June 16, 2025 21:02

evelez7 mentioned this pull request Jun 16, 2025

[clang-doc] add support for concepts #144430

Merged

evelez7 requested a review from ilovepi June 16, 2025 21:05

evelez7 force-pushed the users/evelez7/clang-doc-precommit-concept-tests branch from 8d8b900 to b602047 Compare June 16, 2025 21:39

ilovepi approved these changes Jun 16, 2025

View reviewed changes

This was referenced Jun 20, 2025

[clang-doc] Precommit test for global variables #145069

Merged

[clang-doc] document global variables #145070

Open

[clang-doc] Precommit concept tests

9c18fd3

evelez7 force-pushed the users/evelez7/clang-doc-precommit-concept-tests branch from b602047 to 9c18fd3 Compare June 20, 2025 21:20

evelez7 merged commit 2dfcc43 into main Jun 20, 2025
7 checks passed

evelez7 deleted the users/evelez7/clang-doc-precommit-concept-tests branch June 20, 2025 23:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[clang-doc] Precommit concept tests #144160

[clang-doc] Precommit concept tests #144160

Uh oh!

evelez7 commented Jun 13, 2025

Uh oh!

evelez7 commented Jun 13, 2025 •

edited

Loading

Uh oh!

llvmbot commented Jun 13, 2025

Uh oh!

evelez7 Jun 13, 2025

Uh oh!

ilovepi Jun 14, 2025

Uh oh!

evelez7 Jun 16, 2025

Uh oh!

evelez7 Jun 13, 2025

Uh oh!

ilovepi Jun 14, 2025

Uh oh!

ilovepi left a comment •

edited

Loading

Uh oh!

ilovepi Jun 14, 2025

Uh oh!

ilovepi Jun 14, 2025

Uh oh!

ilovepi left a comment

Uh oh!

evelez7 commented Jun 20, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

		@@ -0,0 +1,37 @@
		// RUN: rm -rf %t && mkdir -p %t
		// RUN: clang-doc --extra-arg -std=c++20 --output=%t --format=json --executor=standalone %s

[clang-doc] Precommit concept tests #144160

[clang-doc] Precommit concept tests #144160

Uh oh!

Conversation

evelez7 commented Jun 13, 2025

Uh oh!

evelez7 commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

llvmbot commented Jun 13, 2025

Uh oh!

evelez7 Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

ilovepi Jun 14, 2025

Choose a reason for hiding this comment

Uh oh!

evelez7 Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

evelez7 Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

ilovepi Jun 14, 2025

Choose a reason for hiding this comment

Uh oh!

ilovepi left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ilovepi Jun 14, 2025

Choose a reason for hiding this comment

Uh oh!

ilovepi Jun 14, 2025

Choose a reason for hiding this comment

Uh oh!

ilovepi left a comment

Choose a reason for hiding this comment

Uh oh!

evelez7 commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Uh oh!

evelez7 commented Jun 13, 2025 •

edited

Loading

ilovepi left a comment •

edited

Loading

evelez7 commented Jun 20, 2025 •

edited

Loading